<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>Xmla.Dataset.Cellset</title>
    <link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.5.1&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
    <link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
    <link rel="shortcut icon" type="image/png" href="..&#x2F;assets/favicon.png">
    <script src="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;combo?3.5.1&#x2F;build&#x2F;yui&#x2F;yui-min.js"></script>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
            
                <h1><img src="..&#x2F;assets/css/logo.png" title=""></h1>
            
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Docs for: </em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
    <h2 class="off-left">APIs</h2>
    <div id="api-tabview" class="tabview">
        <ul class="tabs">
            <li><a href="#api-classes">Classes</a></li>
            <li><a href="#api-modules">Modules</a></li>
        </ul>

        <div id="api-tabview-filter">
            <input type="search" id="api-filter" placeholder="Type to filter APIs">
        </div>

        <div id="api-tabview-panel">
            <ul id="api-classes" class="apis classes">
            
                <li><a href="..&#x2F;classes/Xmla.html">Xmla</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Dataset.html">Xmla.Dataset</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Dataset.Axis.html">Xmla.Dataset.Axis</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Dataset.Cellset.html">Xmla.Dataset.Cellset</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Exception.html">Xmla.Exception</a></li>
            
                <li><a href="..&#x2F;classes/Xmla.Rowset.html">Xmla.Rowset</a></li>
            
            </ul>

            <ul id="api-modules" class="apis modules">
            
                <li><a href="..&#x2F;modules/xmla.html">xmla</a></li>
            
            </ul>
        </div>
    </div>
</div>

            </div>
        </div>
        <div class="yui3-u-3-4">
                <div id="api-options">
        Show:
        <label for="api-show-inherited">
            <input type="checkbox" id="api-show-inherited" checked>
            Inherited
        </label>

        <label for="api-show-protected">
            <input type="checkbox" id="api-show-protected">
            Protected
        </label>

        <label for="api-show-private">
            <input type="checkbox" id="api-show-private">
            Private
        </label>
        <label for="api-show-deprecated">
            <input type="checkbox" id="api-show-deprecated">
            Deprecated
        </label>

    </div>


            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
                        <h1>Xmla.Dataset.Cellset Class</h1>
<div class="box meta">
    

    

    
        <div class="foundat">
            Defined in: <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6358"><code>src&#x2F;Xmla.js:6358</code></a>
        </div>
    

    
        
            Module: <a href="../modules/xmla.html">xmla</a>
        
    

    
</div>



<div class="box intro">
    <p>
This class implements a Cellset object.
</p>

<p><p>
You do not need to instantiate objects of this class yourself.
Rather, the <code><a href="Xmla.Dataset.html#class_Xmla.Dataset">Xmla.Dataset</a></code> class creates instances of this class to represent the cells (the value of the measures) of an MDX query.
(see <code><a href="Xmla.Dataset.html#method_getCellset">getCellset()</a></code>.)</p>
</div>


    <div class="constructor">
        <h2>Constructor</h2>
        <div id="method_Xmla.Dataset.Cellset" class="method item">
    <h3 class="name"><code>Xmla.Dataset.Cellset</code></h3>

    
        <span class="paren">()</span>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6358"><code>src&#x2F;Xmla.js:6358</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        
    </div>

    

    

    
</div>

    </div>


<div id="classdocs" class="tabview">
    <ul class="api-class-tabs">
        <li class="api-class-tab index"><a href="#index">Index</a></li>

        
            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
        
        
        
        
    </ul>

    <div>
        <div id="index" class="api-class-tabpanel index">
            <h2 class="off-left">Item Index</h2>

            
                <div class="index-section methods">
                    <h3>Methods</h3>

                    <ul class="index-list methods">
                        
                            <li class="index-item method">
                                <a href="#method_cellCount">cellCount</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_cellOrdinal">cellOrdinal</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_cellOrdinalForTupleIndexes">cellOrdinalForTupleIndexes</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_cellProperty">cellProperty</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_close">close</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_curr">curr</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_eachCell">eachCell</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getByIndex">getByIndex</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getByOrdinal">getByOrdinal</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_getByTupleIndexes">getByTupleIndexes</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hasCellProperty">hasCellProperty</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_hasMoreCells">hasMoreCells</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_nextCell">nextCell</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_readCell">readCell</a>

                                
                                
                            </li>
                        
                            <li class="index-item method">
                                <a href="#method_reset">reset</a>

                                
                                
                            </li>
                        
                    </ul>
                </div>
            

            

            

            
        </div>

        
            <div id="methods" class="api-class-tabpanel">
                <h2 class="off-left">Methods</h2>

                
                    <div id="method_cellCount" class="method item">
    <h3 class="name"><code>cellCount</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6445"><code>src&#x2F;Xmla.js:6445</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns the number of cells contained in this cellset.
This is the number of cells that is actually present in the cellset - not the number of logical cells.
The nuber of logical cells can be be calculated by multiplying the tuple counts of all axes of the data set.
The XML/A provider will typically not return empty cells, hence, the cellCount may be less than the logical cell count.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    The number of cells in this cellset.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_cellOrdinal" class="method item">
    <h3 class="name"><code>cellOrdinal</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6549"><code>src&#x2F;Xmla.js:6549</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns the ordinal number of the current cell.
The ordinal is the logical cell pointer, which may be different than the physical cell pointer.
To get the physical cell pointer, see <code><a href="#method_curr">curr()</a></code></p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    returns the logical cell pointer.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_cellOrdinalForTupleIndexes" class="method item">
    <h3 class="name"><code>cellOrdinalForTupleIndexes</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>tuple</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6675"><code>src&#x2F;Xmla.js:6675</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Calculate the ordinal based on the specified tuple indexes.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">tuple</code>
                        <span class="type">int...</span>
                    

                    

                    <div class="param-description">
                        <p>index - a variable list of integer arguments. Arguments represent the index of a tuple on the query axes. Tuple indexes should be specified by descending order of axes. For example, if you have a DataSet with 2 Axes, pass the row tuple index as the first argument, and the column tuple index as the last argument.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    The ordinal number for this combination of tuple indexes. This return value can be used as argument for <code><a href="#method_getByOrdinal">getByOrdinal()</a></code>
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_cellProperty" class="method item">
    <h3 class="name"><code>cellProperty</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>propertyName</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Mixed</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6517"><code>src&#x2F;Xmla.js:6517</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Return the value of the current property of the current cell.
XML/A defines these standard properties:<ul>
  <li><code>Value</code></li>
  <li><code>FmtValue</code></li>
  <li><code>ForeColor</code></li>
  <li><code>BackColor</code></li>
</ul>
Whether all these properties are returned depends on the XML/A provider and on the query.
The XML/A provider may return specific additional properties.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">propertyName</code>
                        <span class="type">String</span>
                    

                    

                    <div class="param-description">
                        <p>The name of the property to retrieve.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Mixed</span>:
                    
                    returns the value of the specified property of the current cell.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_close" class="method item">
    <h3 class="name"><code>close</code></h3>

    
        <span class="paren">()</span>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6693"><code>src&#x2F;Xmla.js:6693</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Close this cellset.</p>
    </div>

    

    

    
</div>

                
                    <div id="method_curr" class="method item">
    <h3 class="name"><code>curr</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6491"><code>src&#x2F;Xmla.js:6491</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Returns the internal cell pointer. This is the fysical cell pointer.
To get the logical cell pointer, see <code><a href="#method_cellOrdinal">cellOrdinal()</a></code></p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    returns the internal cell pointer.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_eachCell" class="method item">
    <h3 class="name"><code>eachCell</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>callback</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>scope</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>args</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6620"><code>src&#x2F;Xmla.js:6620</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Iterate through each cell.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">callback</code>
                        <span class="type">Function()</span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">scope</code>
                        <span class="type">Object</span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">args</code>
                        <span class="type">Object</span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getByIndex" class="method item">
    <h3 class="name"><code>getByIndex</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>index</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>object</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Object</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6643"><code>src&#x2F;Xmla.js:6643</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get a cell by its physical index.
This method should typically not be called by clients.
Instead, they should use <code><a href="#method_getByOrdinal">getByOrdinal()</a></code></p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">index</code>
                        <span class="type">Int</span>
                    

                    

                    <div class="param-description">
                        <ul>
<li>the physical index of the cell within the cellset.</li>
</ul>
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">object</code>
                        <span class="type">Object</span>
                    

                    

                    <div class="param-description">
                        <ul>
<li>optional. An object to copy the properties of the specified cell to. If omitted, a new object will be returned instead.</li>
</ul>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Object</span>:
                    
                    An object that represents the cell.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getByOrdinal" class="method item">
    <h3 class="name"><code>getByOrdinal</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>ordinal</code>
                    
                </li>
            
                <li class="arg">
                    
                        <code>object</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Object</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6656"><code>src&#x2F;Xmla.js:6656</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get a cell by its logical index.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">ordinal</code>
                        <span class="type">Int</span>
                    

                    

                    <div class="param-description">
                        <ul>
<li>the ordinal number of the cell to retrieve.</li>
</ul>
                    </div>

                    
                </li>
            
                <li class="param">
                    
                        <code class="param-name">object</code>
                        <span class="type">Object</span>
                    

                    

                    <div class="param-description">
                        <ul>
<li>optional. An object to copy the properties of the specified cell to. If omitted, a new object will be returned instead.</li>
</ul>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Object</span>:
                    
                    An object that represents the cell.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_getByTupleIndexes" class="method item">
    <h3 class="name"><code>getByTupleIndexes</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>ordinal</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Object</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6684"><code>src&#x2F;Xmla.js:6684</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Get the cell corresponding to the specified tuple indexes.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">ordinal</code>
                        <span class="type">int...</span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Object</span>:
                    
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasCellProperty" class="method item">
    <h3 class="name"><code>hasCellProperty</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>propertyName</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6500"><code>src&#x2F;Xmla.js:6500</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Check if the cell has the specified property.
XML/A defines these standard properties:<ul>
  <li><code>Value</code></li>
  <li><code>FmtValue</code></li>
  <li><code>ForeColor</code></li>
  <li><code>BackColor</code></li>
</ul>
Whether all these properties are returned depends on the XML/A provider and on the query.
The XML/A provider may return specific additional properties.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">propertyName</code>
                        <span class="type">String</span>
                    

                    

                    <div class="param-description">
                        <p>The name of the property to check for.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    returns <code>true</code> if the current cell has the specified property, <code>false</code> if it doesn't.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_hasMoreCells" class="method item">
    <h3 class="name"><code>hasMoreCells</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6466"><code>src&#x2F;Xmla.js:6466</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Check if there are cells to iterate through.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Boolean</span>:
                    
                    <code>true</code> if there are more cells to iterate, <code>false</code> if there are no more cells to iterate.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_nextCell" class="method item">
    <h3 class="name"><code>nextCell</code></h3>

    
        <span class="paren">()</span>
    

    
        <span class="returns-inline">
            <span class="type">Int</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6474"><code>src&#x2F;Xmla.js:6474</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Advance to the next (physical) cell.
Note that this method may appear to be skipping cells. This happens when the XML/A provider omits empty cells in the response.</p>
    </div>

    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Int</span>:
                    
                    returns the ordinal of the next cell, or -1 if there was no next cell.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_readCell" class="method item">
    <h3 class="name"><code>readCell</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>object</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    
        <span class="returns-inline">
            <span class="type">Object</span>
        </span>
    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6610"><code>src&#x2F;Xmla.js:6610</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Reads the current cell into the specified object.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">object</code>
                        <span class="type">Object</span>
                    

                    

                    <div class="param-description">
                        <p>An existing object to use for the current cell. If omitted, a new object will be created.</p>
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    
        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                
                    
                        <span class="type">Object</span>:
                    
                    An object that represents the current cell.
                
            </div>
        </div>
    

    
</div>

                
                    <div id="method_reset" class="method item">
    <h3 class="name"><code>reset</code></h3>

    
        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
            
                <li class="arg">
                    
                        <code>idx</code>
                    
                </li>
            
            </ul><span class="paren">)</span>
        </div>
    

    

    

    

    

    

    

    

    <div class="meta">
        
            
                
                <p>
                
                Defined in
                
            
        
        
        <a href="..&#x2F;files&#x2F;src_Xmla.js.html#l6456"><code>src&#x2F;Xmla.js:6456</code></a>
        
        </p>


        

        
    </div>

    <div class="description">
        <p>Resets the internal cell pointer to the argument, or to 0 if the argument is omitted.
Normally, you shouldn't have to call this method yourself.</p>
    </div>

    
        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
            
                <li class="param">
                    
                        <code class="param-name">idx</code>
                        <span class="type">Int</span>
                    

                    

                    <div class="param-description">
                         
                    </div>

                    
                </li>
            
            </ul>
        </div>
    

    

    
</div>

                
            </div>
        

        

        

        
    </div>
</div>

                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="..&#x2F;assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="..&#x2F;assets/js/yui-prettify.js"></script>
<script src="..&#x2F;assets/../api.js"></script>
<script src="..&#x2F;assets/js/api-filter.js"></script>
<script src="..&#x2F;assets/js/api-list.js"></script>
<script src="..&#x2F;assets/js/api-search.js"></script>
<script src="..&#x2F;assets/js/apidocs.js"></script>
</body>
</html>
